<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>TorqueDataModelTask xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/apache/torque/task/TorqueDataModelTask.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <strong>package</strong> <a href="../../../../org/apache/torque/task/package-summary.html">org.apache.torque.task</a>;
<a name="2" href="#2">2</a>   
<a name="3" href="#3">3</a>   <em class="comment">/*</em>
<a name="4" href="#4">4</a>   <em class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a name="5" href="#5">5</a>   <em class="comment"> * or more contributor license agreements.  See the NOTICE file</em>
<a name="6" href="#6">6</a>   <em class="comment"> * distributed with this work for additional information</em>
<a name="7" href="#7">7</a>   <em class="comment"> * regarding copyright ownership.  The ASF licenses this file</em>
<a name="8" href="#8">8</a>   <em class="comment"> * to you under the Apache License, Version 2.0 (the</em>
<a name="9" href="#9">9</a>   <em class="comment"> * "License"); you may not use this file except in compliance</em>
<a name="10" href="#10">10</a>  <em class="comment"> * with the License.  You may obtain a copy of the License at</em>
<a name="11" href="#11">11</a>  <em class="comment"> *</em>
<a name="12" href="#12">12</a>  <em class="comment"> *   <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="13" href="#13">13</a>  <em class="comment"> *</em>
<a name="14" href="#14">14</a>  <em class="comment"> * Unless required by applicable law or agreed to in writing,</em>
<a name="15" href="#15">15</a>  <em class="comment"> * software distributed under the License is distributed on an</em>
<a name="16" href="#16">16</a>  <em class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a name="17" href="#17">17</a>  <em class="comment"> * KIND, either express or implied.  See the License for the</em>
<a name="18" href="#18">18</a>  <em class="comment"> * specific language governing permissions and limitations</em>
<a name="19" href="#19">19</a>  <em class="comment"> * under the License.</em>
<a name="20" href="#20">20</a>  <em class="comment"> */</em>
<a name="21" href="#21">21</a>  
<a name="22" href="#22">22</a>  <strong>import</strong> java.io.ByteArrayInputStream;
<a name="23" href="#23">23</a>  <strong>import</strong> java.io.ByteArrayOutputStream;
<a name="24" href="#24">24</a>  <strong>import</strong> java.io.File;
<a name="25" href="#25">25</a>  <strong>import</strong> java.io.IOException;
<a name="26" href="#26">26</a>  <strong>import</strong> java.io.InputStream;
<a name="27" href="#27">27</a>  <strong>import</strong> java.io.InputStreamReader;
<a name="28" href="#28">28</a>  <strong>import</strong> java.io.LineNumberReader;
<a name="29" href="#29">29</a>  <strong>import</strong> java.io.PrintStream;
<a name="30" href="#30">30</a>  <strong>import</strong> java.io.UnsupportedEncodingException;
<a name="31" href="#31">31</a>  <strong>import</strong> java.io.Writer;
<a name="32" href="#32">32</a>  <strong>import</strong> java.util.ArrayList;
<a name="33" href="#33">33</a>  <strong>import</strong> java.util.Date;
<a name="34" href="#34">34</a>  <strong>import</strong> java.util.Hashtable;
<a name="35" href="#35">35</a>  <strong>import</strong> java.util.Iterator;
<a name="36" href="#36">36</a>  <strong>import</strong> java.util.List;
<a name="37" href="#37">37</a>  <strong>import</strong> java.util.Map;
<a name="38" href="#38">38</a>  
<a name="39" href="#39">39</a>  <strong>import</strong> org.apache.commons.lang.StringUtils;
<a name="40" href="#40">40</a>  <strong>import</strong> org.apache.texen.Generator;
<a name="41" href="#41">41</a>  <strong>import</strong> org.apache.texen.ant.TexenTask;
<a name="42" href="#42">42</a>  <strong>import</strong> org.apache.tools.ant.BuildException;
<a name="43" href="#43">43</a>  <strong>import</strong> org.apache.tools.ant.DirectoryScanner;
<a name="44" href="#44">44</a>  <strong>import</strong> org.apache.tools.ant.types.FileSet;
<a name="45" href="#45">45</a>  <strong>import</strong> org.apache.torque.engine.EngineException;
<a name="46" href="#46">46</a>  <strong>import</strong> org.apache.torque.engine.database.model.Database;
<a name="47" href="#47">47</a>  <strong>import</strong> org.apache.torque.engine.database.transform.XmlToAppData;
<a name="48" href="#48">48</a>  <strong>import</strong> org.apache.velocity.VelocityContext;
<a name="49" href="#49">49</a>  <strong>import</strong> org.apache.velocity.app.VelocityEngine;
<a name="50" href="#50">50</a>  <strong>import</strong> org.apache.velocity.context.Context;
<a name="51" href="#51">51</a>  <strong>import</strong> org.apache.velocity.exception.MethodInvocationException;
<a name="52" href="#52">52</a>  <strong>import</strong> org.apache.velocity.exception.ParseErrorException;
<a name="53" href="#53">53</a>  <strong>import</strong> org.apache.velocity.exception.ResourceNotFoundException;
<a name="54" href="#54">54</a>  <strong>import</strong> org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader;
<a name="55" href="#55">55</a>  <strong>import</strong> org.apache.velocity.runtime.resource.loader.FileResourceLoader;
<a name="56" href="#56">56</a>  
<a name="57" href="#57">57</a>  <em>/**<em>*</em></em>
<a name="58" href="#58">58</a>  <em> * A base torque task that uses either a single XML schema</em>
<a name="59" href="#59">59</a>  <em> * representing a data model, or a &amp;lt;fileset&amp;gt; of XML schemas.</em>
<a name="60" href="#60">60</a>  <em> * We are making the assumption that an XML schema representing</em>
<a name="61" href="#61">61</a>  <em> * a data model contains tables for a &lt;strong>single&lt;/strong></em>
<a name="62" href="#62">62</a>  <em> * database.</em>
<a name="63" href="#63">63</a>  <em> *</em>
<a name="64" href="#64">64</a>  <em> * @author &lt;a href="<a href="mailto:jvanzyl@zenplex.com" target="alexandria_uri">mailto:jvanzyl@zenplex.com</a>">Jason van Zyl&lt;/a></em>
<a name="65" href="#65">65</a>  <em> * @author &lt;a href="<a href="mailto:dlr@finemaltcoding.com" target="alexandria_uri">mailto:dlr@finemaltcoding.com</a>">Daniel Rall&lt;/a></em>
<a name="66" href="#66">66</a>  <em> */</em>
<a name="67" href="#67">67</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../org/apache/torque/task/TorqueDataModelTask.html">TorqueDataModelTask</a> <strong>extends</strong> TexenTask
<a name="68" href="#68">68</a>  {
<a name="69" href="#69">69</a>      <em>/**<em>*</em></em>
<a name="70" href="#70">70</a>  <em>     * XML that describes the database model, this is transformed</em>
<a name="71" href="#71">71</a>  <em>     * into the application model object.</em>
<a name="72" href="#72">72</a>  <em>     */</em>
<a name="73" href="#73">73</a>      <strong>protected</strong> String xmlFile;
<a name="74" href="#74">74</a>  
<a name="75" href="#75">75</a>      <em>/**<em>* Fileset of XML schemas which represent our data models. */</em></em>
<a name="76" href="#76">76</a>      <strong>protected</strong> List filesets = <strong>new</strong> ArrayList();
<a name="77" href="#77">77</a>  
<a name="78" href="#78">78</a>      <em>/**<em>* Data models that we collect. One from each XML schema file. */</em></em>
<a name="79" href="#79">79</a>      <strong>protected</strong> List dataModels = <strong>new</strong> ArrayList();
<a name="80" href="#80">80</a>  
<a name="81" href="#81">81</a>      <em>/**<em>* Velocity context which exposes our objects in the templates. */</em></em>
<a name="82" href="#82">82</a>      <strong>protected</strong> Context context;
<a name="83" href="#83">83</a>  
<a name="84" href="#84">84</a>      <em>/**<em>*</em></em>
<a name="85" href="#85">85</a>  <em>     * Map of data model name to database name.</em>
<a name="86" href="#86">86</a>  <em>     * Should probably stick to the convention of them being the same but</em>
<a name="87" href="#87">87</a>  <em>     * I know right now in a lot of cases they won't be.</em>
<a name="88" href="#88">88</a>  <em>     */</em>
<a name="89" href="#89">89</a>      <strong>protected</strong> Hashtable dataModelDbMap;
<a name="90" href="#90">90</a>  
<a name="91" href="#91">91</a>      <em>/**<em>*</em></em>
<a name="92" href="#92">92</a>  <em>     * Hashtable containing the names of all the databases</em>
<a name="93" href="#93">93</a>  <em>     * in our collection of schemas.</em>
<a name="94" href="#94">94</a>  <em>     */</em>
<a name="95" href="#95">95</a>      <strong>protected</strong> Hashtable databaseNames;
<a name="96" href="#96">96</a>  
<a name="97" href="#97">97</a>      <em class="comment">//!! This is probably a crappy idea having the sql file -> db map</em>
<a name="98" href="#98">98</a>      <em class="comment">// here. I can't remember why I put it here at the moment ...</em>
<a name="99" href="#99">99</a>      <em class="comment">// maybe I was going to map something else. It can probably</em>
<a name="100" href="#100">100</a>     <em class="comment">// move into the SQL task.</em>
<a name="101" href="#101">101</a> 
<a name="102" href="#102">102</a>     <em>/**<em>*</em></em>
<a name="103" href="#103">103</a> <em>     * Name of the properties file that maps an SQL file</em>
<a name="104" href="#104">104</a> <em>     * to a particular database.</em>
<a name="105" href="#105">105</a> <em>     */</em>
<a name="106" href="#106">106</a>     <strong>protected</strong> String sqldbmap;
<a name="107" href="#107">107</a> 
<a name="108" href="#108">108</a>     <em>/**<em>* The target database(s) we are generating SQL for. */</em></em>
<a name="109" href="#109">109</a>     <strong>private</strong> String targetDatabase;
<a name="110" href="#110">110</a> 
<a name="111" href="#111">111</a>     <em>/**<<a href="../../../../em>* <a href="////////////Target Java package to place the generated files in/ */</em>/package-summary/html">Target Java package to place the generated files in/ */</em></a></em>/package-summary.html">em>* <a href="../../../../Target Java package to place the generated files in/ */</em>/package-summary.html">Target Java package to place the generated files in. */</em></a></em></a>
<a name="112" href="#112">112</a>     <strong>private</strong> String targetPackage;
<a name="113" href="#113">113</a> 
<a name="114" href="#114">114</a> 
<a name="115" href="#115">115</a>     <em>/**<em>*</em></em>
<a name="116" href="#116">116</a> <em>     * Set the sqldbmap.</em>
<a name="117" href="#117">117</a> <em>     *</em>
<a name="118" href="#118">118</a> <em>     * @param sqldbmap th db map</em>
<a name="119" href="#119">119</a> <em>     */</em>
<a name="120" href="#120">120</a>     <strong>public</strong> <strong>void</strong> setSqlDbMap(String sqldbmap)
<a name="121" href="#121">121</a>     {
<a name="122" href="#122">122</a>         <em class="comment">//!! Make all these references files not strings.</em>
<a name="123" href="#123">123</a>         <strong>this</strong>.sqldbmap = getProject().resolveFile(sqldbmap).toString();
<a name="124" href="#124">124</a>     }
<a name="125" href="#125">125</a> 
<a name="126" href="#126">126</a>     <em>/**<em>*</em></em>
<a name="127" href="#127">127</a> <em>     * Get the sqldbmap.</em>
<a name="128" href="#128">128</a> <em>     *</em>
<a name="129" href="#129">129</a> <em>     * @return String sqldbmap.</em>
<a name="130" href="#130">130</a> <em>     */</em>
<a name="131" href="#131">131</a>     <strong>public</strong> String getSqlDbMap()
<a name="132" href="#132">132</a>     {
<a name="133" href="#133">133</a>         <strong>return</strong> sqldbmap;
<a name="134" href="#134">134</a>     }
<a name="135" href="#135">135</a> 
<a name="136" href="#136">136</a>     <em>/**<em>*</em></em>
<a name="137" href="#137">137</a> <em>     * Return the data models that have been processed.</em>
<a name="138" href="#138">138</a> <em>     *</em>
<a name="139" href="#139">139</a> <em>     * @return List data models</em>
<a name="140" href="#140">140</a> <em>     */</em>
<a name="141" href="#141">141</a>     <strong>public</strong> List getDataModels()
<a name="142" href="#142">142</a>     {
<a name="143" href="#143">143</a>         <strong>return</strong> dataModels;
<a name="144" href="#144">144</a>     }
<a name="145" href="#145">145</a> 
<a name="146" href="#146">146</a>     <em>/**<em>*</em></em>
<a name="147" href="#147">147</a> <em>     * Return the data model to database name map.</em>
<a name="148" href="#148">148</a> <em>     *</em>
<a name="149" href="#149">149</a> <em>     * @return Hashtable data model name to database name map.</em>
<a name="150" href="#150">150</a> <em>     */</em>
<a name="151" href="#151">151</a>     <strong>public</strong> Hashtable getDataModelDbMap()
<a name="152" href="#152">152</a>     {
<a name="153" href="#153">153</a>         <strong>return</strong> dataModelDbMap;
<a name="154" href="#154">154</a>     }
<a name="155" href="#155">155</a> 
<a name="156" href="#156">156</a>     <em>/**<em>*</em></em>
<a name="157" href="#157">157</a> <em>     * Get the xml schema describing the application model.</em>
<a name="158" href="#158">158</a> <em>     *</em>
<a name="159" href="#159">159</a> <em>     * @return  String xml schema file.</em>
<a name="160" href="#160">160</a> <em>     */</em>
<a name="161" href="#161">161</a>     <strong>public</strong> String getXmlFile()
<a name="162" href="#162">162</a>     {
<a name="163" href="#163">163</a>         <strong>return</strong> xmlFile;
<a name="164" href="#164">164</a>     }
<a name="165" href="#165">165</a> 
<a name="166" href="#166">166</a>     <em>/**<em>*</em></em>
<a name="167" href="#167">167</a> <em>     * Set the xml schema describing the application model.</em>
<a name="168" href="#168">168</a> <em>     *</em>
<a name="169" href="#169">169</a> <em>     * @param xmlFile The new XmlFile value</em>
<a name="170" href="#170">170</a> <em>     */</em>
<a name="171" href="#171">171</a>     <strong>public</strong> <strong>void</strong> setXmlFile(String xmlFile)
<a name="172" href="#172">172</a>     {
<a name="173" href="#173">173</a>         <strong>this</strong>.xmlFile = getProject().resolveFile(xmlFile).toString();
<a name="174" href="#174">174</a>     }
<a name="175" href="#175">175</a> 
<a name="176" href="#176">176</a>     <em>/**<em>*</em></em>
<a name="177" href="#177">177</a> <em>     * Adds a set of xml schema files (nested fileset attribute).</em>
<a name="178" href="#178">178</a> <em>     *</em>
<a name="179" href="#179">179</a> <em>     * @param set a Set of xml schema files</em>
<a name="180" href="#180">180</a> <em>     */</em>
<a name="181" href="#181">181</a>     <strong>public</strong> <strong>void</strong> addFileset(FileSet set)
<a name="182" href="#182">182</a>     {
<a name="183" href="#183">183</a>         filesets.add(set);
<a name="184" href="#184">184</a>     }
<a name="185" href="#185">185</a> 
<a name="186" href="#186">186</a>     <em>/**<em>*</em></em>
<a name="187" href="#187">187</a> <em>     * Get the current target database.</em>
<a name="188" href="#188">188</a> <em>     *</em>
<a name="189" href="#189">189</a> <em>     * @return String target database(s)</em>
<a name="190" href="#190">190</a> <em>     */</em>
<a name="191" href="#191">191</a>     <strong>public</strong> String getTargetDatabase()
<a name="192" href="#192">192</a>     {
<a name="193" href="#193">193</a>         <strong>return</strong> targetDatabase;
<a name="194" href="#194">194</a>     }
<a name="195" href="#195">195</a> 
<a name="196" href="#196">196</a>     <em>/**<em>*</em></em>
<a name="197" href="#197">197</a> <em>     * Set the current target database. (e.g. mysql, oracle, ..)</em>
<a name="198" href="#198">198</a> <em>     *</em>
<a name="199" href="#199">199</a> <em>     * @param v target database(s)</em>
<a name="200" href="#200">200</a> <em>     */</em>
<a name="201" href="#201">201</a>     <strong>public</strong> <strong>void</strong> setTargetDatabase(String v)
<a name="202" href="#202">202</a>     {
<a name="203" href="#203">203</a>         targetDatabase = v;
<a name="204" href="#204">204</a>     }
<a name="205" href="#205">205</a> 
<a name="206" href="#206">206</a>     <em>/**<em>*</em></em>
<a name="207" href="#207">207</a> <em>     * Get the current target package.</em>
<a name="208" href="#208">208</a> <em>     *</em>
<a name="209" href="#209">209</a> <em>     * @return return target java package.</em>
<a name="210" href="#210">210</a> <em>     */</em>
<a name="211" href="#211">211</a>     <strong>public</strong> String getTargetPackage()
<a name="212" href="#212">212</a>     {
<a name="213" href="#213">213</a>         <strong>return</strong> targetPackage;
<a name="214" href="#214">214</a>     }
<a name="215" href="#215">215</a> 
<a name="216" href="#216">216</a>     <em>/**<em>*</em></em>
<a name="217" href="#217">217</a> <em>     * Set the current target package. This is where generated java classes will</em>
<a name="218" href="#218">218</a> <em>     * live.</em>
<a name="219" href="#219">219</a> <em>     *</em>
<a name="220" href="#220">220</a> <em>     * @param v target java package.</em>
<a name="221" href="#221">221</a> <em>     */</em>
<a name="222" href="#222">222</a>     <strong>public</strong> <strong>void</strong> setTargetPackage(String v)
<a name="223" href="#223">223</a>     {
<a name="224" href="#224">224</a>         targetPackage = v;
<a name="225" href="#225">225</a>     }
<a name="226" href="#226">226</a> 
<a name="227" href="#227">227</a>     <em>/**<em>*</em></em>
<a name="228" href="#228">228</a> <em>     * Set up the initial context for generating the SQL from the XML schema.</em>
<a name="229" href="#229">229</a> <em>     *</em>
<a name="230" href="#230">230</a> <em>     * @return the context</em>
<a name="231" href="#231">231</a> <em>     * @throws Exception</em>
<a name="232" href="#232">232</a> <em>     */</em>
<a name="233" href="#233">233</a>     <strong>public</strong> Context initControlContext() throws Exception
<a name="234" href="#234">234</a>     {
<a name="235" href="#235">235</a>         <a href="../../../../org/apache/torque/engine/database/transform/XmlToAppData.html">XmlToAppData</a> xmlParser;
<a name="236" href="#236">236</a> 
<a name="237" href="#237">237</a>         <strong>if</strong> (xmlFile == <strong>null</strong> &amp;&amp; filesets.isEmpty())
<a name="238" href="#238">238</a>         {
<a name="239" href="#239">239</a>             <strong>throw</strong> <strong>new</strong> BuildException(<span class="string">"You must specify an XML schema or "</span>
<a name="240" href="#240">240</a>                     + <span class="string">"fileset of XML schemas!"</span>);
<a name="241" href="#241">241</a>         }
<a name="242" href="#242">242</a> 
<a name="243" href="#243">243</a>         <strong>try</strong>
<a name="244" href="#244">244</a>         {
<a name="245" href="#245">245</a>             <strong>if</strong> (xmlFile != <strong>null</strong>)
<a name="246" href="#246">246</a>             {
<a name="247" href="#247">247</a>                 <em class="comment">// Transform the XML database schema into</em>
<a name="248" href="#248">248</a>                 <em class="comment">// data model object.</em>
<a name="249" href="#249">249</a>                 xmlParser = <strong>new</strong> <a href="../../../../org/apache/torque/engine/database/transform/XmlToAppData.html">XmlToAppData</a>(getTargetDatabase(),
<a name="250" href="#250">250</a>                         getTargetPackage());
<a name="251" href="#251">251</a>                 <a href="../../../../org/apache/torque/engine/database/model/Database.html">Database</a> ad = xmlParser.parseFile(xmlFile);
<a name="252" href="#252">252</a>                 ad.setFileName(grokName(xmlFile));
<a name="253" href="#253">253</a>                 dataModels.add(ad);
<a name="254" href="#254">254</a>             }
<a name="255" href="#255">255</a>             <strong>else</strong>
<a name="256" href="#256">256</a>             {
<a name="257" href="#257">257</a>                 <em class="comment">// Deal with the filesets.</em>
<a name="258" href="#258">258</a>                 <strong>for</strong> (<strong>int</strong> i = 0; i &lt; filesets.size(); i++)
<a name="259" href="#259">259</a>                 {
<a name="260" href="#260">260</a>                     FileSet fs = (FileSet) filesets.get(i);
<a name="261" href="#261">261</a>                     DirectoryScanner ds = fs.getDirectoryScanner(getProject());
<a name="262" href="#262">262</a>                     File srcDir = fs.getDir(getProject());
<a name="263" href="#263">263</a> 
<a name="264" href="#264">264</a>                     String[] dataModelFiles = ds.getIncludedFiles();
<a name="265" href="#265">265</a> 
<a name="266" href="#266">266</a>                     <em class="comment">// Make a transaction for each file</em>
<a name="267" href="#267">267</a>                     <strong>for</strong> (<strong>int</strong> j = 0; j &lt; dataModelFiles.length; j++)
<a name="268" href="#268">268</a>                     {
<a name="269" href="#269">269</a>                         File f = <strong>new</strong> File(srcDir, dataModelFiles[j]);
<a name="270" href="#270">270</a>                         xmlParser = <strong>new</strong> <a href="../../../../org/apache/torque/engine/database/transform/XmlToAppData.html">XmlToAppData</a>(getTargetDatabase(),
<a name="271" href="#271">271</a>                                 getTargetPackage());
<a name="272" href="#272">272</a>                         <a href="../../../../org/apache/torque/engine/database/model/Database.html">Database</a> ad = xmlParser.parseFile(f.toString());
<a name="273" href="#273">273</a>                         ad.setFileName(grokName(f.toString()));
<a name="274" href="#274">274</a>                         dataModels.add(ad);
<a name="275" href="#275">275</a>                     }
<a name="276" href="#276">276</a>                 }
<a name="277" href="#277">277</a>             }
<a name="278" href="#278">278</a> 
<a name="279" href="#279">279</a>             Iterator i = dataModels.iterator();
<a name="280" href="#280">280</a>             databaseNames = <strong>new</strong> Hashtable();
<a name="281" href="#281">281</a>             dataModelDbMap = <strong>new</strong> Hashtable();
<a name="282" href="#282">282</a> 
<a name="283" href="#283">283</a>             <em class="comment">// Different datamodels may state the same database</em>
<a name="284" href="#284">284</a>             <em class="comment">// names, we just want the unique names of databases.</em>
<a name="285" href="#285">285</a>             <strong>while</strong> (i.hasNext())
<a name="286" href="#286">286</a>             {
<a name="287" href="#287">287</a>                 <a href="../../../../org/apache/torque/engine/database/model/Database.html">Database</a> database = (Database) i.next();
<a name="288" href="#288">288</a>                 databaseNames.put(database.getName(), database.getName());
<a name="289" href="#289">289</a>                 dataModelDbMap.put(database.getFileName(), database.getName());
<a name="290" href="#290">290</a>             }
<a name="291" href="#291">291</a>         }
<a name="292" href="#292">292</a>         <strong>catch</strong> (EngineException ee)
<a name="293" href="#293">293</a>         {
<a name="294" href="#294">294</a>             <strong>throw</strong> <strong>new</strong> BuildException(ee);
<a name="295" href="#295">295</a>         }
<a name="296" href="#296">296</a> 
<a name="297" href="#297">297</a>         context = <strong>new</strong> VelocityContext();
<a name="298" href="#298">298</a> 
<a name="299" href="#299">299</a>         <em class="comment">// Place our set of data models into the context along</em>
<a name="300" href="#300">300</a>         <em class="comment">// with the names of the databases as a convenience for now.</em>
<a name="301" href="#301">301</a>         context.put(<span class="string">"dataModels"</span>, dataModels);
<a name="302" href="#302">302</a>         context.put(<span class="string">"databaseNames"</span>, databaseNames);
<a name="303" href="#303">303</a>         context.put(<span class="string">"targetDatabase"</span>, targetDatabase);
<a name="304" href="#304">304</a>         context.put(<span class="string">"targetPackage"</span>, targetPackage);
<a name="305" href="#305">305</a> 
<a name="306" href="#306">306</a>         <strong>return</strong> context;
<a name="307" href="#307">307</a>     }
<a name="308" href="#308">308</a> 
<a name="309" href="#309">309</a>     <em>/**<em>*</em></em>
<a name="310" href="#310">310</a> <em>     * Change type of "now" to java.util.Date</em>
<a name="311" href="#311">311</a> <em>     *</em>
<a name="312" href="#312">312</a> <em>     * @see org.apache.texen.ant.TexenTask#populateInitialContext(org.apache.velocity.context.Context)</em>
<a name="313" href="#313">313</a> <em>     */</em>
<a name="314" href="#314">314</a>     <strong>protected</strong> <strong>void</strong> populateInitialContext(Context context) throws Exception
<a name="315" href="#315">315</a>     {
<a name="316" href="#316">316</a>         <strong>super</strong>.populateInitialContext(context);
<a name="317" href="#317">317</a>         context.put(<span class="string">"now"</span>, <strong>new</strong> Date());
<a name="318" href="#318">318</a>     }
<a name="319" href="#319">319</a> 
<a name="320" href="#320">320</a>     <em>/**<em>*</em></em>
<a name="321" href="#321">321</a> <em>     * Gets a name to use for the application's data model.</em>
<a name="322" href="#322">322</a> <em>     *</em>
<a name="323" href="#323">323</a> <em>     * @param xmlFile The path to the XML file housing the data model.</em>
<a name="324" href="#324">324</a> <em>     * @return The name to use for the &lt;code>AppData&lt;/code>.</em>
<a name="325" href="#325">325</a> <em>     */</em>
<a name="326" href="#326">326</a>     <strong>private</strong> String grokName(String xmlFile)
<a name="327" href="#327">327</a>     {
<a name="328" href="#328">328</a>         <em class="comment">// This can't be set from the file name as it is an unreliable</em>
<a name="329" href="#329">329</a>         <em class="comment">// method of naming the descriptor. Not everyone uses the same</em>
<a name="330" href="#330">330</a>         <em class="comment">// method as I do in the TDK. jvz.</em>
<a name="331" href="#331">331</a> 
<a name="332" href="#332">332</a>         String name = <span class="string">"data-model"</span>;
<a name="333" href="#333">333</a>         <strong>int</strong> i = xmlFile.lastIndexOf(System.getProperty(<span class="string">"file.separator"</span>));
<a name="334" href="#334">334</a>         <strong>if</strong> (i != -1)
<a name="335" href="#335">335</a>         {
<a name="336" href="#336">336</a>             <em class="comment">// Creep forward to the start of the file name.</em>
<a name="337" href="#337">337</a>             i++;
<a name="338" href="#338">338</a> 
<a name="339" href="#339">339</a>             <strong>int</strong> j = xmlFile.lastIndexOf('.');
<a name="340" href="#340">340</a>             <strong>if</strong> (i &lt; j)
<a name="341" href="#341">341</a>             {
<a name="342" href="#342">342</a>                 name = xmlFile.substring(i, j);
<a name="343" href="#343">343</a>             }
<a name="344" href="#344">344</a>             <strong>else</strong>
<a name="345" href="#345">345</a>             {
<a name="346" href="#346">346</a>                 <em class="comment">// Weirdo</em>
<a name="347" href="#347">347</a>                 name = xmlFile.substring(i);
<a name="348" href="#348">348</a>             }
<a name="349" href="#349">349</a>         }
<a name="350" href="#350">350</a>         <strong>return</strong> name;
<a name="351" href="#351">351</a>     }
<a name="352" href="#352">352</a> 
<a name="353" href="#353">353</a>     <em>/**<em>*</em></em>
<a name="354" href="#354">354</a> <em>     * Override Texen's context properties to map the</em>
<a name="355" href="#355">355</a> <em>     * torque.xxx properties (including defaults set by the</em>
<a name="356" href="#356">356</a> <em>     * org/apache/torque/defaults.properties) to just xxx.</em>
<a name="357" href="#357">357</a> <em>     *</em>
<a name="358" href="#358">358</a> <em>     * &lt;p></em>
<a name="359" href="#359">359</a> <em>     * Also, move xxx.yyy properties to xxxYyy as Velocity</em>
<a name="360" href="#360">360</a> <em>     * doesn't like the xxx.yyy syntax.</em>
<a name="361" href="#361">361</a> <em>     * &lt;/p></em>
<a name="362" href="#362">362</a> <em>     *</em>
<a name="363" href="#363">363</a> <em>     * @param file the file to read the properties from</em>
<a name="364" href="#364">364</a> <em>     */</em>
<a name="365" href="#365">365</a>     <strong>public</strong> <strong>void</strong> setContextProperties(String file)
<a name="366" href="#366">366</a>     {
<a name="367" href="#367">367</a>         <strong>super</strong>.setContextProperties(file);
<a name="368" href="#368">368</a> 
<a name="369" href="#369">369</a>         <em class="comment">// Map the torque.xxx elements from the env to the contextProperties</em>
<a name="370" href="#370">370</a>         Hashtable env = <strong>super</strong>.getProject().getProperties();
<a name="371" href="#371">371</a>         <strong>for</strong> (Iterator i = env.entrySet().iterator(); i.hasNext();)
<a name="372" href="#372">372</a>         {
<a name="373" href="#373">373</a>             Map.Entry entry = (Map.Entry) i.next();
<a name="374" href="#374">374</a>             String key = (String) entry.getKey();
<a name="375" href="#375">375</a>             <strong>if</strong> (key.startsWith(<span class="string">"torque."</span>))
<a name="376" href="#376">376</a>             {
<a name="377" href="#377">377</a>                 String newKey = key.substring(<span class="string">"torque."</span>.length());
<a name="378" href="#378">378</a>                 <strong>int</strong> j = newKey.indexOf(<span class="string">"."</span>);
<a name="379" href="#379">379</a>                 <strong>while</strong> (j != -1)
<a name="380" href="#380">380</a>                 {
<a name="381" href="#381">381</a>                     newKey =
<a name="382" href="#382">382</a>                         newKey.substring(0, j)
<a name="383" href="#383">383</a>                         +  StringUtils.capitalize(newKey.substring(j + 1));
<a name="384" href="#384">384</a>                     j = newKey.indexOf(<span class="string">"."</span>);
<a name="385" href="#385">385</a>                 }
<a name="386" href="#386">386</a> 
<a name="387" href="#387">387</a>                 contextProperties.setProperty(newKey, entry.getValue());
<a name="388" href="#388">388</a>             }
<a name="389" href="#389">389</a>         }
<a name="390" href="#390">390</a>     }
<a name="391" href="#391">391</a>     <em>/**<em>*</em></em>
<a name="392" href="#392">392</a> <em>     * This message fragment (telling users to consult the log or</em>
<a name="393" href="#393">393</a> <em>     * invoke ant with the -debug flag) is appended to rethrown</em>
<a name="394" href="#394">394</a> <em>     * exception messages.</em>
<a name="395" href="#395">395</a> <em>     */</em>
<a name="396" href="#396">396</a>     <strong>private</strong> <strong>final</strong> <strong>static</strong> String ERR_MSG_FRAGMENT = 
<a name="397" href="#397">397</a>         <span class="string">". For more information consult the velocity log, or invoke ant "</span> +
<a name="398" href="#398">398</a>     <span class="string">"with the -debug flag."</span>;
<a name="399" href="#399">399</a> 
<a name="400" href="#400">400</a>     <em>/**<em>*</em></em>
<a name="401" href="#401">401</a> <em>     * This method creates an VelocityEngine instance, parses</em>
<a name="402" href="#402">402</a> <em>     * every template and creates the corresponding output.</em>
<a name="403" href="#403">403</a> <em>     * </em>
<a name="404" href="#404">404</a> <em>     * Unfortunately the TextenTask.execute() method makes</em>
<a name="405" href="#405">405</a> <em>     * everything for us but we just want to set our own</em>
<a name="406" href="#406">406</a> <em>     * VelocityTemplateLoader. </em>
<a name="407" href="#407">407</a> <em>     * TODO: change once TEXEN-14 is resolved and out.</em>
<a name="408" href="#408">408</a> <em>     *  </em>
<a name="409" href="#409">409</a> <em>     * @see org.apache.texen.ant.TexenTask#execute()</em>
<a name="410" href="#410">410</a> <em>     */</em>
<a name="411" href="#411">411</a>     <strong>public</strong> <strong>void</strong> execute() throws BuildException 
<a name="412" href="#412">412</a>     {
<a name="413" href="#413">413</a>         <em class="comment">// Make sure the template path is set.</em>
<a name="414" href="#414">414</a>         <strong>if</strong> (templatePath == <strong>null</strong> &amp;&amp; useClasspath == false)
<a name="415" href="#415">415</a>         {
<a name="416" href="#416">416</a>             <strong>throw</strong> <strong>new</strong> BuildException(
<a name="417" href="#417">417</a>                 <span class="string">"The template path needs to be defined if you are not using "</span>
<a name="418" href="#418">418</a>                         + <span class="string">"the classpath for locating templates!"</span>);
<a name="419" href="#419">419</a>         }
<a name="420" href="#420">420</a> 
<a name="421" href="#421">421</a>         <em class="comment">// Make sure the control template is set.</em>
<a name="422" href="#422">422</a>         <strong>if</strong> (controlTemplate == <strong>null</strong>)
<a name="423" href="#423">423</a>         {
<a name="424" href="#424">424</a>             <strong>throw</strong> <strong>new</strong> BuildException(
<a name="425" href="#425">425</a>                     <span class="string">"The control template needs to be defined!"</span>);
<a name="426" href="#426">426</a>         }
<a name="427" href="#427">427</a> 
<a name="428" href="#428">428</a>         <em class="comment">// Make sure the output directory is set.</em>
<a name="429" href="#429">429</a>         <strong>if</strong> (outputDirectory == <strong>null</strong>)
<a name="430" href="#430">430</a>         {
<a name="431" href="#431">431</a>             <strong>throw</strong> <strong>new</strong> BuildException(
<a name="432" href="#432">432</a>                     <span class="string">"The output directory needs to be defined!"</span>);
<a name="433" href="#433">433</a>         }
<a name="434" href="#434">434</a> 
<a name="435" href="#435">435</a>         <em class="comment">// Make sure there is an output file.</em>
<a name="436" href="#436">436</a>         <strong>if</strong> (outputFile == <strong>null</strong>)
<a name="437" href="#437">437</a>         {
<a name="438" href="#438">438</a>             <strong>throw</strong> <strong>new</strong> BuildException(<span class="string">"The output file needs to be defined!"</span>);
<a name="439" href="#439">439</a>         }
<a name="440" href="#440">440</a> 
<a name="441" href="#441">441</a>         VelocityEngine ve = <strong>new</strong> VelocityEngine();
<a name="442" href="#442">442</a> 
<a name="443" href="#443">443</a>         <strong>try</strong>
<a name="444" href="#444">444</a>         {
<a name="445" href="#445">445</a>             <em class="comment">// Setup the Velocity Runtime.</em>
<a name="446" href="#446">446</a>             <strong>if</strong> (templatePath != <strong>null</strong>)
<a name="447" href="#447">447</a>             {
<a name="448" href="#448">448</a>                 log(<span class="string">"Using templatePath: "</span> + templatePath, project.MSG_VERBOSE);
<a name="449" href="#449">449</a>                 ve.setProperty(<span class="string">"torque"</span> + VelocityEngine.FILE_RESOURCE_LOADER_PATH,
<a name="450" href="#450">450</a>                         templatePath);
<a name="451" href="#451">451</a> 
<a name="452" href="#452">452</a>                 <em class="comment">// TR: We need our own FileResourceLoader</em>
<a name="453" href="#453">453</a>                 ve.addProperty(VelocityEngine.RESOURCE_LOADER, <span class="string">"torquefile"</span>);
<a name="454" href="#454">454</a>                 ve.setProperty(<span class="string">"torquefile."</span> + VelocityEngine.RESOURCE_LOADER
<a name="455" href="#455">455</a>                             + <span class="string">".instance"</span>,
<a name="456" href="#456">456</a>                         <strong>new</strong> TorqueFileResourceLoader(<strong>this</strong>));
<a name="457" href="#457">457</a>             }
<a name="458" href="#458">458</a> 
<a name="459" href="#459">459</a>             <strong>if</strong> (useClasspath)
<a name="460" href="#460">460</a>             {
<a name="461" href="#461">461</a>                 log(<span class="string">"Using classpath"</span>);
<a name="462" href="#462">462</a>                 <em class="comment">// TR: We need our own ClasspathResourceLoader</em>
<a name="463" href="#463">463</a>                 ve.addProperty(VelocityEngine.RESOURCE_LOADER, <span class="string">"classpath"</span>);
<a name="464" href="#464">464</a> 
<a name="465" href="#465">465</a>                 ve.setProperty(<span class="string">"classpath."</span> + VelocityEngine.RESOURCE_LOADER
<a name="466" href="#466">466</a>                         + <span class="string">".instance"</span>, <strong>new</strong> TorqueClasspathResourceLoader(<strong>this</strong>));
<a name="467" href="#467">467</a> 
<a name="468" href="#468">468</a>                 ve.setProperty(<span class="string">"classpath."</span> + VelocityEngine.RESOURCE_LOADER
<a name="469" href="#469">469</a>                         + <span class="string">".cache"</span>, <span class="string">"false"</span>);
<a name="470" href="#470">470</a> 
<a name="471" href="#471">471</a>                 ve.setProperty(<span class="string">"classpath."</span> + VelocityEngine.RESOURCE_LOADER
<a name="472" href="#472">472</a>                         + <span class="string">".modificationCheckInterval"</span>, <span class="string">"2"</span>);
<a name="473" href="#473">473</a>             }
<a name="474" href="#474">474</a> 
<a name="475" href="#475">475</a>             ve.init();
<a name="476" href="#476">476</a> 
<a name="477" href="#477">477</a>             <em class="comment">// Create the text generator.</em>
<a name="478" href="#478">478</a>             Generator generator = Generator.getInstance();
<a name="479" href="#479">479</a>             generator.setVelocityEngine(ve);
<a name="480" href="#480">480</a>             generator.setOutputPath(outputDirectory);
<a name="481" href="#481">481</a>             generator.setInputEncoding(inputEncoding);
<a name="482" href="#482">482</a>             generator.setOutputEncoding(outputEncoding);
<a name="483" href="#483">483</a> 
<a name="484" href="#484">484</a>             <strong>if</strong> (templatePath != <strong>null</strong>)
<a name="485" href="#485">485</a>             {
<a name="486" href="#486">486</a>                 generator.setTemplatePath(templatePath);
<a name="487" href="#487">487</a>             }
<a name="488" href="#488">488</a> 
<a name="489" href="#489">489</a>             <em class="comment">// Make sure the output directory exists, if it doesn't</em>
<a name="490" href="#490">490</a>             <em class="comment">// then create it.</em>
<a name="491" href="#491">491</a>             File file = <strong>new</strong> File(outputDirectory);
<a name="492" href="#492">492</a>             <strong>if</strong> (!file.exists())
<a name="493" href="#493">493</a>             {
<a name="494" href="#494">494</a>                 file.mkdirs();
<a name="495" href="#495">495</a>             }
<a name="496" href="#496">496</a> 
<a name="497" href="#497">497</a>             String path = outputDirectory + File.separator + outputFile;
<a name="498" href="#498">498</a>             log(<span class="string">"Generating to file "</span> + path, project.MSG_INFO);
<a name="499" href="#499">499</a>             Writer writer = generator.getWriter(path, outputEncoding);
<a name="500" href="#500">500</a> 
<a name="501" href="#501">501</a>             <em class="comment">// The generator and the output path should</em>
<a name="502" href="#502">502</a>             <em class="comment">// be placed in the init context here and</em>
<a name="503" href="#503">503</a>             <em class="comment">// not in the generator class itself.</em>
<a name="504" href="#504">504</a>             Context c = initControlContext();
<a name="505" href="#505">505</a> 
<a name="506" href="#506">506</a>             <em class="comment">// Everything in the generator class should be</em>
<a name="507" href="#507">507</a>             <em class="comment">// pulled out and placed in here. What the generator</em>
<a name="508" href="#508">508</a>             <em class="comment">// class does can probably be added to the Velocity</em>
<a name="509" href="#509">509</a>             <em class="comment">// class and the generator class can probably</em>
<a name="510" href="#510">510</a>             <em class="comment">// be removed all together.</em>
<a name="511" href="#511">511</a>             populateInitialContext(c);
<a name="512" href="#512">512</a> 
<a name="513" href="#513">513</a>             <em class="comment">// Feed all the options into the initial</em>
<a name="514" href="#514">514</a>             <em class="comment">// control context so they are available</em>
<a name="515" href="#515">515</a>             <em class="comment">// in the control/worker templates.</em>
<a name="516" href="#516">516</a>             <strong>if</strong> (contextProperties != <strong>null</strong>)
<a name="517" href="#517">517</a>             {
<a name="518" href="#518">518</a>                 Iterator i = contextProperties.getKeys();
<a name="519" href="#519">519</a> 
<a name="520" href="#520">520</a>                 <strong>while</strong> (i.hasNext())
<a name="521" href="#521">521</a>                 {
<a name="522" href="#522">522</a>                     String property = (String) i.next();
<a name="523" href="#523">523</a>                     String value = contextProperties.getString(property);
<a name="524" href="#524">524</a> 
<a name="525" href="#525">525</a>                     <em class="comment">// Now lets quickly check to see if what</em>
<a name="526" href="#526">526</a>                     <em class="comment">// we have is numeric and try to put it</em>
<a name="527" href="#527">527</a>                     <em class="comment">// into the context as an Integer.</em>
<a name="528" href="#528">528</a>                     <strong>try</strong>
<a name="529" href="#529">529</a>                     {
<a name="530" href="#530">530</a>                         c.put(property, <strong>new</strong> Integer(value));
<a name="531" href="#531">531</a>                     } <strong>catch</strong> (NumberFormatException nfe)
<a name="532" href="#532">532</a>                     {
<a name="533" href="#533">533</a>                         <em class="comment">// Now we will try to place the value into</em>
<a name="534" href="#534">534</a>                         <em class="comment">// the context as a boolean value if it</em>
<a name="535" href="#535">535</a>                         <em class="comment">// maps to a valid boolean value.</em>
<a name="536" href="#536">536</a>                         String booleanString = contextProperties
<a name="537" href="#537">537</a>                                 .testBoolean(value);
<a name="538" href="#538">538</a> 
<a name="539" href="#539">539</a>                         <strong>if</strong> (booleanString != <strong>null</strong>)
<a name="540" href="#540">540</a>                         {
<a name="541" href="#541">541</a>                             c.put(property, <strong>new</strong> Boolean(booleanString));
<a name="542" href="#542">542</a>                         } <strong>else</strong>
<a name="543" href="#543">543</a>                         {
<a name="544" href="#544">544</a>                             <em class="comment">// We are going to do something special</em>
<a name="545" href="#545">545</a>                             <em class="comment">// for properties that have a "file.contents"</em>
<a name="546" href="#546">546</a>                             <em class="comment">// suffix: for these properties will pull</em>
<a name="547" href="#547">547</a>                             <em class="comment">// in the contents of the file and make</em>
<a name="548" href="#548">548</a>                             <em class="comment">// them available in the context. So for</em>
<a name="549" href="#549">549</a>                             <em class="comment">// a line like the following in a properties file:</em>
<a name="550" href="#550">550</a>                             <em class="comment">//</em>
<a name="551" href="#551">551</a>                             <em class="comment">// license.file.contents = license.txt</em>
<a name="552" href="#552">552</a>                             <em class="comment">//</em>
<a name="553" href="#553">553</a>                             <em class="comment">// We will pull in the contents of license.txt</em>
<a name="554" href="#554">554</a>                             <em class="comment">// and make it available in the context as</em>
<a name="555" href="#555">555</a>                             <em class="comment">// $license. This should make texen a little</em>
<a name="556" href="#556">556</a>                             <em class="comment">// more flexible.</em>
<a name="557" href="#557">557</a>                             <strong>if</strong> (property.endsWith(<span class="string">"file.contents"</span>))
<a name="558" href="#558">558</a>                             {
<a name="559" href="#559">559</a>                                 <em class="comment">// We need to turn the license file from</em>
<a name="560" href="#560">560</a>                                 <em class="comment">// relative to</em>
<a name="561" href="#561">561</a>                                 <em class="comment">// absolute, and let Ant help :)</em>
<a name="562" href="#562">562</a>                                 value = org.apache.velocity.util.StringUtils
<a name="563" href="#563">563</a>                                         .fileContentsToString(project
<a name="564" href="#564">564</a>                                                 .resolveFile(value)
<a name="565" href="#565">565</a>                                                 .getCanonicalPath());
<a name="566" href="#566">566</a> 
<a name="567" href="#567">567</a>                                 property = property.substring(0, property
<a name="568" href="#568">568</a>                                         .indexOf(<span class="string">"file.contents"</span>) - 1);
<a name="569" href="#569">569</a>                             }
<a name="570" href="#570">570</a> 
<a name="571" href="#571">571</a>                             c.put(property, value);
<a name="572" href="#572">572</a>                         }
<a name="573" href="#573">573</a>                     }
<a name="574" href="#574">574</a>                 }
<a name="575" href="#575">575</a>             }
<a name="576" href="#576">576</a> 
<a name="577" href="#577">577</a>             writer.write(generator.parse(controlTemplate, c));
<a name="578" href="#578">578</a>             writer.flush();
<a name="579" href="#579">579</a>             writer.close();
<a name="580" href="#580">580</a>             generator.shutdown();
<a name="581" href="#581">581</a>             cleanup();
<a name="582" href="#582">582</a>         } 
<a name="583" href="#583">583</a>         <strong>catch</strong> (BuildException e)
<a name="584" href="#584">584</a>         {
<a name="585" href="#585">585</a>             <strong>throw</strong> e;
<a name="586" href="#586">586</a>         } 
<a name="587" href="#587">587</a>         <strong>catch</strong> (MethodInvocationException e)
<a name="588" href="#588">588</a>         {
<a name="589" href="#589">589</a>             <strong>throw</strong> <strong>new</strong> BuildException(<span class="string">"Exception thrown by '"</span>
<a name="590" href="#590">590</a>                     + e.getReferenceName() + <span class="string">"."</span> + e.getMethodName() + <span class="string">"'"</span>
<a name="591" href="#591">591</a>                     + ERR_MSG_FRAGMENT, e.getWrappedThrowable());
<a name="592" href="#592">592</a>         } 
<a name="593" href="#593">593</a>         <strong>catch</strong> (ParseErrorException e)
<a name="594" href="#594">594</a>         {
<a name="595" href="#595">595</a>             <strong>throw</strong> <strong>new</strong> BuildException(
<a name="596" href="#596">596</a>                     <span class="string">"Velocity syntax error"</span> + ERR_MSG_FRAGMENT, e);
<a name="597" href="#597">597</a>         } 
<a name="598" href="#598">598</a>         <strong>catch</strong> (ResourceNotFoundException e)
<a name="599" href="#599">599</a>         {
<a name="600" href="#600">600</a>             <strong>throw</strong> <strong>new</strong> BuildException(
<a name="601" href="#601">601</a>                     <span class="string">"Resource not found"</span> + ERR_MSG_FRAGMENT, 
<a name="602" href="#602">602</a>                     e);
<a name="603" href="#603">603</a>         } 
<a name="604" href="#604">604</a>         <strong>catch</strong> (Exception e)
<a name="605" href="#605">605</a>         {
<a name="606" href="#606">606</a>             <strong>throw</strong> <strong>new</strong> BuildException(
<a name="607" href="#607">607</a>                     <span class="string">"Generation failed"</span> + ERR_MSG_FRAGMENT, 
<a name="608" href="#608">608</a>                     e);
<a name="609" href="#609">609</a>         }
<a name="610" href="#610">610</a>     }
<a name="611" href="#611">611</a> 
<a name="612" href="#612">612</a>     <em>/**<em>*</em></em>
<a name="613" href="#613">613</a> <em>     * This method filters the template and replaces some</em>
<a name="614" href="#614">614</a> <em>     * unwanted characters. For example it removes leading</em>
<a name="615" href="#615">615</a> <em>     * spaces in front of velocity commands and replaces</em>
<a name="616" href="#616">616</a> <em>     * tabs with spaces to prevent bounces in different</em>
<a name="617" href="#617">617</a> <em>     * code editors with different tab-width-setting.</em>
<a name="618" href="#618">618</a> <em>     * </em>
<a name="619" href="#619">619</a> <em>     * @param resource the input stream to filter</em>
<a name="620" href="#620">620</a> <em>     * </em>
<a name="621" href="#621">621</a> <em>     * @return the filtered input stream.</em>
<a name="622" href="#622">622</a> <em>     * </em>
<a name="623" href="#623">623</a> <em>     * @throws IOException if creating, reading or writing to a stream fails.</em>
<a name="624" href="#624">624</a> <em>     */</em>
<a name="625" href="#625">625</a>     <strong>protected</strong> InputStream filter(InputStream resource) throws IOException
<a name="626" href="#626">626</a>     {
<a name="627" href="#627">627</a>         InputStreamReader streamReader;
<a name="628" href="#628">628</a>         <strong>if</strong> (inputEncoding != <strong>null</strong>)
<a name="629" href="#629">629</a>         {
<a name="630" href="#630">630</a>             streamReader = <strong>new</strong> InputStreamReader(resource, inputEncoding);
<a name="631" href="#631">631</a>         }
<a name="632" href="#632">632</a>         <strong>else</strong>
<a name="633" href="#633">633</a>         {
<a name="634" href="#634">634</a>             streamReader = <strong>new</strong> InputStreamReader(resource);
<a name="635" href="#635">635</a>         }
<a name="636" href="#636">636</a>         LineNumberReader lineNumberReader = <strong>new</strong> LineNumberReader(streamReader);
<a name="637" href="#637">637</a>         String line = <strong>null</strong>;
<a name="638" href="#638">638</a>         ByteArrayOutputStream baos = <strong>new</strong> ByteArrayOutputStream();
<a name="639" href="#639">639</a>         PrintStream ps = <strong>null</strong>;
<a name="640" href="#640">640</a>         <strong>if</strong> (inputEncoding != <strong>null</strong>)
<a name="641" href="#641">641</a>         {
<a name="642" href="#642">642</a>             ps = <strong>new</strong> PrintStream(baos, <strong>true</strong>, inputEncoding);
<a name="643" href="#643">643</a>         }
<a name="644" href="#644">644</a>         <strong>else</strong>
<a name="645" href="#645">645</a>         {
<a name="646" href="#646">646</a>             ps = <strong>new</strong> PrintStream(baos, <strong>true</strong>);
<a name="647" href="#647">647</a>         }
<a name="648" href="#648">648</a> 
<a name="649" href="#649">649</a>         <strong>while</strong> ((line = lineNumberReader.readLine()) != <strong>null</strong>)
<a name="650" href="#650">650</a>         {
<a name="651" href="#651">651</a>             <em class="comment">// remove leading spaces in front of velocity commands and comments</em>
<a name="652" href="#652">652</a>             line = line.replaceAll(<span class="string">"^&#47;&#47;s*#"</span>, <span class="string">"#"</span>);
<a name="653" href="#653">653</a>             <em class="comment">// replace tabs with spaces to prevent bounces in editors</em>
<a name="654" href="#654">654</a>             line = line.replaceAll(<span class="string">"\t"</span>, <span class="string">"    "</span>);
<a name="655" href="#655">655</a>             ps.println(line);
<a name="656" href="#656">656</a>         }
<a name="657" href="#657">657</a>         ps.flush();
<a name="658" href="#658">658</a>         ps.close();
<a name="659" href="#659">659</a> 
<a name="660" href="#660">660</a>         <strong>return</strong> <strong>new</strong> ByteArrayInputStream(baos.toByteArray());
<a name="661" href="#661">661</a>     }
<a name="662" href="#662">662</a> 
<a name="663" href="#663">663</a>     
<a name="664" href="#664">664</a>     <em>/**<em>*</em></em>
<a name="665" href="#665">665</a> <em>     * A custom classpath resource loader which filters tabs and removes spaces</em>
<a name="666" href="#666">666</a> <em>     * from lines with velocity commands. </em>
<a name="667" href="#667">667</a> <em>     */</em>
<a name="668" href="#668">668</a>     <strong>public</strong> <strong>static</strong> <strong>class</strong> TorqueClasspathResourceLoader 
<a name="669" href="#669">669</a>             <strong>extends</strong> ClasspathResourceLoader
<a name="670" href="#670">670</a>     {
<a name="671" href="#671">671</a>         <em>/**<em>*</em></em>
<a name="672" href="#672">672</a> <em>         * The task in which this resource loader is used.</em>
<a name="673" href="#673">673</a> <em>         */</em>
<a name="674" href="#674">674</a>         <strong>private</strong> <a href="../../../../org/apache/torque/task/TorqueDataModelTask.html">TorqueDataModelTask</a> task;
<a name="675" href="#675">675</a>         
<a name="676" href="#676">676</a>         <em>/**<em>*</em></em>
<a name="677" href="#677">677</a> <em>         * Constructor.</em>
<a name="678" href="#678">678</a> <em>         *</em>
<a name="679" href="#679">679</a> <em>         * @param task the task in which this resource loader is used.</em>
<a name="680" href="#680">680</a> <em>         */</em>
<a name="681" href="#681">681</a>         <strong>public</strong> TorqueClasspathResourceLoader(<a href="../../../../org/apache/torque/task/TorqueDataModelTask.html">TorqueDataModelTask</a> task)
<a name="682" href="#682">682</a>         {
<a name="683" href="#683">683</a>             <strong>this</strong>.task = task;
<a name="684" href="#684">684</a>         }
<a name="685" href="#685">685</a>         
<a name="686" href="#686">686</a>         <em>/**<em>*</em></em>
<a name="687" href="#687">687</a> <em>         * @see org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader#getResourceStream(java.lang.String)</em>
<a name="688" href="#688">688</a> <em>         */</em>
<a name="689" href="#689">689</a>         <strong>public</strong> <strong>synchronized</strong> InputStream getResourceStream(String name) 
<a name="690" href="#690">690</a>                 throws ResourceNotFoundException 
<a name="691" href="#691">691</a>         {
<a name="692" href="#692">692</a>             InputStream source = <strong>null</strong>;
<a name="693" href="#693">693</a>             <strong>try</strong> 
<a name="694" href="#694">694</a>             {
<a name="695" href="#695">695</a>                 source = <strong>super</strong>.getResourceStream(name);
<a name="696" href="#696">696</a>                 <strong>return</strong> task.filter(source);
<a name="697" href="#697">697</a>             } 
<a name="698" href="#698">698</a>             <strong>catch</strong> (IOException uee)
<a name="699" href="#699">699</a>             {
<a name="700" href="#700">700</a>                 task.log(uee.getMessage());
<a name="701" href="#701">701</a>                 <strong>throw</strong> <strong>new</strong> ResourceNotFoundException(uee.getMessage());
<a name="702" href="#702">702</a>             }
<a name="703" href="#703">703</a>             <strong>finally</strong>
<a name="704" href="#704">704</a>             {
<a name="705" href="#705">705</a>                 <strong>if</strong> (source != <strong>null</strong>)
<a name="706" href="#706">706</a>                 {
<a name="707" href="#707">707</a>                     <strong>try</strong>
<a name="708" href="#708">708</a>                     {
<a name="709" href="#709">709</a>                         source.close();
<a name="710" href="#710">710</a>                     }
<a name="711" href="#711">711</a>                     <strong>catch</strong> (IOException e)
<a name="712" href="#712">712</a>                     {
<a name="713" href="#713">713</a>                         task.log(e.getMessage());
<a name="714" href="#714">714</a>                     }
<a name="715" href="#715">715</a>                 }
<a name="716" href="#716">716</a>             }
<a name="717" href="#717">717</a>         }
<a name="718" href="#718">718</a>     }
<a name="719" href="#719">719</a> 
<a name="720" href="#720">720</a>     <em>/**<em>*</em></em>
<a name="721" href="#721">721</a> <em>     * A custom file resource loader which filters tabs and removes spaces</em>
<a name="722" href="#722">722</a> <em>     * from lines with velocity commands. </em>
<a name="723" href="#723">723</a> <em>     */</em>
<a name="724" href="#724">724</a>     <strong>public</strong> <strong>static</strong> <strong>class</strong> TorqueFileResourceLoader
<a name="725" href="#725">725</a>             <strong>extends</strong> FileResourceLoader
<a name="726" href="#726">726</a>     {
<a name="727" href="#727">727</a>         <em>/**<em>*</em></em>
<a name="728" href="#728">728</a> <em>         * The task in which this resource loader is used.</em>
<a name="729" href="#729">729</a> <em>         */</em>
<a name="730" href="#730">730</a>         <strong>private</strong> <a href="../../../../org/apache/torque/task/TorqueDataModelTask.html">TorqueDataModelTask</a> task;
<a name="731" href="#731">731</a>         
<a name="732" href="#732">732</a>         <em>/**<em>*</em></em>
<a name="733" href="#733">733</a> <em>         * Constructor.</em>
<a name="734" href="#734">734</a> <em>         *</em>
<a name="735" href="#735">735</a> <em>         * @param task the task in which this resource loader is used.</em>
<a name="736" href="#736">736</a> <em>         */</em>
<a name="737" href="#737">737</a>         <strong>public</strong> TorqueFileResourceLoader(<a href="../../../../org/apache/torque/task/TorqueDataModelTask.html">TorqueDataModelTask</a> task)
<a name="738" href="#738">738</a>         {
<a name="739" href="#739">739</a>             <strong>this</strong>.task = task;
<a name="740" href="#740">740</a>         }
<a name="741" href="#741">741</a>         
<a name="742" href="#742">742</a>         <em>/**<em>*</em></em>
<a name="743" href="#743">743</a> <em>         * @see org.apache.velocity.runtime.resource.loader.FileResourceLoader#getResourceStream(java.lang.String)</em>
<a name="744" href="#744">744</a> <em>         */</em>
<a name="745" href="#745">745</a>         <strong>public</strong> <strong>synchronized</strong> InputStream getResourceStream(
<a name="746" href="#746">746</a>                 String name) 
<a name="747" href="#747">747</a>                 throws ResourceNotFoundException
<a name="748" href="#748">748</a>         {
<a name="749" href="#749">749</a>             InputStream source = <strong>null</strong>;
<a name="750" href="#750">750</a>             <strong>try</strong> 
<a name="751" href="#751">751</a>             {
<a name="752" href="#752">752</a>                 source = <strong>super</strong>.getResourceStream(name);
<a name="753" href="#753">753</a>                 <strong>return</strong> task.filter(source);
<a name="754" href="#754">754</a>             } 
<a name="755" href="#755">755</a>             <strong>catch</strong> (IOException uee)
<a name="756" href="#756">756</a>             {
<a name="757" href="#757">757</a>                 task.log(uee.getMessage());
<a name="758" href="#758">758</a>                 <strong>throw</strong> <strong>new</strong> ResourceNotFoundException(uee.getMessage());
<a name="759" href="#759">759</a>             }
<a name="760" href="#760">760</a>             <strong>finally</strong>
<a name="761" href="#761">761</a>             {
<a name="762" href="#762">762</a>                 <strong>if</strong> (source != <strong>null</strong>)
<a name="763" href="#763">763</a>                 {
<a name="764" href="#764">764</a>                     <strong>try</strong>
<a name="765" href="#765">765</a>                     {
<a name="766" href="#766">766</a>                         source.close();
<a name="767" href="#767">767</a>                     }
<a name="768" href="#768">768</a>                     <strong>catch</strong> (IOException e)
<a name="769" href="#769">769</a>                     {
<a name="770" href="#770">770</a>                         task.log(e.getMessage());
<a name="771" href="#771">771</a>                     }
<a name="772" href="#772">772</a>                 }
<a name="773" href="#773">773</a>             }
<a name="774" href="#774">774</a>         }
<a name="775" href="#775">775</a>     }
<a name="776" href="#776">776</a> }
<a name="777" href="#777">777</a> 
<a name="778" href="#778">778</a> 
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

